TRAMP User Manual

tramp version 2.2.0 User Manual

This file documents tramp version 2.2.0, a remote file editing package for GNU Emacs.

tramp stands for `Transparent Remote (file) Access, Multiple Protocol'. This package provides remote file editing, similar to Ange-FTP.

The difference is that Ange-FTP uses FTP to transfer files between the local and the remote host, whereas tramp uses a combination of rsh and rcp or other work-alike programs, such as ssh/scp.

You can find the latest version of this document on the web at http://www.gnu.org/software/tramp/.

The latest release of tramp is available for download, or you may see Obtaining Tramp for more details, including the CVS server details.

tramp also has a Savannah Project Page.

There is a mailing list for tramp, available at tramp-devel@gnu.org, and archived at the tramp Mail Archive. Older archives are located at SourceForge Mail Archive and The Mail Archive.

Copyright © 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being “A GNU Manual”, and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License”.

(a) The FSF's Back-Cover Text is: “You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.”

• Overview: What tramp can and cannot do.

For the end user:

• Obtaining Tramp: How to obtain tramp.
• History: History of tramp.
• Configuration: Configuring tramp for use.
• Usage: An overview of the operation of tramp.
• Bug Reports: Reporting Bugs and Problems.
• Frequently Asked Questions: Questions and answers from the mailing list.
• Function Index: tramp functions.
• Variable Index: User options and variables.
• Concept Index: An item for each concept.

For the developer:

• Files directories and localnames: How file names, directories and localnames are mangled and managed.
• Traces and Profiles: How to Customize Traces.
• Issues: Debatable Issues and What Was Decided.
• GNU Free Documentation License: The license for this documentation.

--- The Detailed Node Listing ---

Configuring tramp for use

• Connection types: Types of connections made to remote machines.
• Inline methods: Inline methods.
• External methods: External methods.
• GVFS based methods: GVFS based external methods.
• Gateway methods: Gateway methods.
• Default Method: Selecting a default method.
• Default User: Selecting a default user.
• Default Host: Selecting a default host.
• Multi-hops: Connecting to a remote host using multiple hops.
• Customizing Methods: Using Non-Standard Methods.
• Customizing Completion: Selecting config files for user/host name completion.
• Password handling: Reusing passwords for several connections.
• Connection caching: Reusing connection related information.
• Remote Programs: How tramp finds and uses programs on the remote machine.
• Remote shell setup: Remote shell setup hints.
• Windows setup hints: Issues with Cygwin ssh.
• Auto-save and Backup: Auto-save and Backup.

Using tramp

• Filename Syntax: tramp filename conventions.
• Alternative Syntax: URL-like filename syntax.
• Filename completion: Filename completion.
• Remote processes: Integration with other GNU Emacs packages.
• Cleanup remote connections: Cleanup remote connections.

How file names, directories and localnames are mangled and managed

• Localname deconstruction: Breaking a localname into its components.
• External packages: Integration with external Lisp packages.